/***********************************************************************
	filename: 	StaticRendererProperties.h
	created:	Sat Sep 17 2005
	author:		Tomas Lindquist Olsen (based on code by Paul D Turner)
	
	purpose:	Interface to properties for FalagardStatic (base class) widget.
*************************************************************************/

#ifndef _StaticRendererProperties_h_
#define _StaticRendererProperties_h_

#include "../hgeGuiProperty.h"

// Start of StaticRendererProperties namespace section
/*!
\brief
	Namespace containing all classes that make up the properties interface for the FalagardStatic (base) class
*/
namespace RendererProperties
{

/*!
\brief
	Property to access the state of the frame background setting for the FalagardStatic widget.

	\par Usage:
		- Name: BackgroundEnabled
		- Format: "[text]".

	\par Where [Text] is:
		- "True" to indicate that the background is enabled.
		- "False" to indicate that the background is disabled.
*/
class BackgroundEnabled : public Property
{
public:
	BackgroundEnabled() : Property(
		"BackgroundEnabled",
		"Property to get/set the state of the frame background setting for the FalagardStatic widget.  Value is either \"True\" or \"False\".",
		"True")
	{}

	String	get(const PropertyReceiver* receiver) const;
	void	set(PropertyReceiver* receiver, const String& value);
};

/*!
\brief
Property to access the image for the FalagardStaticImage widget.

\par Usage:
- Name: Image
- Format: "set:[text] image:[text]".

\par Where:
- set:[text] is the name of the Imageset containing the image.  The Imageset name should not contain spaces.  The Imageset specified must already be loaded.
- image:[text] is the name of the Image on the specified Imageset.  The Image name should not contain spaces.
*/
class Image : public Property
{
public:
	Image() : Property(
		"Image",
		"Property to get/set the image for the FalagardStaticImage widget.  Value should be \"set:[imageset name] image:[image name]\".",
		"")
	{}

	String  get(const PropertyReceiver* receiver) const;
	void    set(PropertyReceiver* receiver, const String& value);
};

} // End of  RendererProperties namespace section

#endif	// end of guard _StaticRendererProperties_h_
